home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / sgttrf.z / sgttrf
Encoding:
Text File  |  2002-10-03  |  4.1 KB  |  133 lines
  1.  
  2.  
  3.  
  4. SSSSGGGGTTTTTTTTRRRRFFFF((((3333SSSS))))                                                          SSSSGGGGTTTTTTTTRRRRFFFF((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SGTTRF - compute an LU factorization of a real tridiagonal matrix A using
  10.      elimination with partial pivoting and row interchanges
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE SGTTRF( N, DL, D, DU, DU2, IPIV, INFO )
  14.  
  15.          INTEGER        INFO, N
  16.  
  17.          INTEGER        IPIV( * )
  18.  
  19.          REAL           D( * ), DL( * ), DU( * ), DU2( * )
  20.  
  21. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  22.      These routines are part of the SCSL Scientific Library and can be loaded
  23.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  24.      directs the linker to use the multi-processor version of the library.
  25.  
  26.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  27.      4 bytes (32 bits). Another version of SCSL is available in which integers
  28.      are 8 bytes (64 bits).  This version allows the user access to larger
  29.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  30.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  31.      only one of the two versions; 4-byte integer and 8-byte integer library
  32.      calls cannot be mixed.
  33.  
  34. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  35.      SGTTRF computes an LU factorization of a real tridiagonal matrix A using
  36.      elimination with partial pivoting and row interchanges. The factorization
  37.      has the form
  38.         A = L * U
  39.      where L is a product of permutation and unit lower bidiagonal matrices
  40.      and U is upper triangular with nonzeros in only the main diagonal and
  41.      first two superdiagonals.
  42.  
  43.  
  44. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  45.      N       (input) INTEGER
  46.              The order of the matrix A.
  47.  
  48.      DL      (input/output) REAL array, dimension (N-1)
  49.              On entry, DL must contain the (n-1) sub-diagonal elements of A.
  50.  
  51.              On exit, DL is overwritten by the (n-1) multipliers that define
  52.              the matrix L from the LU factorization of A.
  53.  
  54.      D       (input/output) REAL array, dimension (N)
  55.              On entry, D must contain the diagonal elements of A.
  56.  
  57.              On exit, D is overwritten by the n diagonal elements of the upper
  58.              triangular matrix U from the LU factorization of A.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSGGGGTTTTTTTTRRRRFFFF((((3333SSSS))))                                                          SSSSGGGGTTTTTTTTRRRRFFFF((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      DU      (input/output) REAL array, dimension (N-1)
  75.              On entry, DU must contain the (n-1) super-diagonal elements of A.
  76.  
  77.              On exit, DU is overwritten by the (n-1) elements of the first
  78.              super-diagonal of U.
  79.  
  80.      DU2     (output) REAL array, dimension (N-2)
  81.              On exit, DU2 is overwritten by the (n-2) elements of the second
  82.              super-diagonal of U.
  83.  
  84.      IPIV    (output) INTEGER array, dimension (N)
  85.              The pivot indices; for 1 <= i <= n, row i of the matrix was
  86.              interchanged with row IPIV(i).  IPIV(i) will always be either i
  87.              or i+1; IPIV(i) = i indicates a row interchange was not required.
  88.  
  89.      INFO    (output) INTEGER
  90.              = 0:  successful exit
  91.              < 0:  if INFO = -k, the k-th argument had an illegal value
  92.              > 0:  if INFO = k, U(k,k) is exactly zero. The factorization has
  93.              been completed, but the factor U is exactly singular, and
  94.              division by zero will occur if it is used to solve a system of
  95.              equations.
  96.  
  97. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  98.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  99.  
  100.      This man page is available only online.
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.